68. Spring Boot应用

68.1 创建自己的FailureAnalyzer

FailureAnalyzer是拦截启动时的异常并将它转换为可读消息的很好方式,Spring Boot为应用上下文相关异常, JSR-303校验等提供分析器,实际上创建你自己的分析器也相当简单。

AbstractFailureAnalyzerFailureAnalyzer的一个方便扩展,根据指定类型的异常是否出现来进行处理。你可以继承它,这样就可以处理实际出现的异常。如果出于某些原因,不能处理该异常,那就返回null让其他实现处理。

FailureAnalyzer的实现需要注册到META-INF/spring.factories,以下注册了ProjectConstraintViolationFailureAnalyzer

org.springframework.boot.diagnostics.FailureAnalyzer=\
com.example.ProjectConstraintViolationFailureAnalyzer

68.2 解决自动配置问题

Spring Boot自动配置总是尝试尽最大努力去做正确的事,但有时候会失败并且很难说出失败原因。

在每个Spring Boot ApplicationContext中都存在一个相当有用的ConditionEvaluationReport。如果开启DEBUG日志输出,你将会看到它。如果你使用spring-boot-actuator,则会有一个autoconfig的端点,它将以JSON形式渲染该报告。你还可以使用它调试应用程序,并能查看Spring Boot运行时都添加了哪些特性(及哪些没添加)。

通过查看源码和javadoc可以获取更多问题的答案,以下是一些经验:

  • 查找名为*AutoConfiguration的类并阅读源码,特别是@Conditional*注解,这可以帮你找出它们启用哪些特性及何时启用。 将--debug添加到命令行或添加系统属性-Ddebug可以在控制台查看日志,该日志会记录你的应用中所有自动配置的决策。在运行Actuator的app中,通过查看autoconfig端点(/autoconfig或等效的JMX)可以获取相同信息。
  • 查找@ConfigurationProperties的类(比如ServerProperties)并看下有哪些可用的外部配置选项。@ConfigurationProperties类有一个用于充当外部配置前缀的name属性,因此ServerPropertiesprefix="server",它的配置属性有server.portserver.address等。在运行Actuator的应用中可以查看configprops端点。
  • 查看RelaxedPropertyResolver明确地将配置从Environment暴露出去,它经常会使用前缀。
  • 查看@Value注解,它直接绑定到Environment。相比RelaxedPropertyResolver,这种方式稍微缺乏灵活性,但它也允许松散的绑定,特别是OS环境变量(所以CAPITALS_AND_UNDERSCORESperiod.separated的同义词)。
  • 查看@ConditionalOnExpression注解,它根据SpEL表达式的结果来开启或关闭特性,通常使用解析自Environment的占位符进行计算。

68.3 启动前自定义Environment或ApplicationContext

每个SpringApplication都有ApplicationListenersApplicationContextInitializers,用于自定义上下文(context)或环境(environment)。Spring Boot从META-INF/spring.factories下加载很多这样的内部使用的自定义,有很多方法可以注册其他的自定义:

  • 以编程方式为每个应用注册自定义,通过在SpringApplication运行前调用它的addListenersaddInitializers方法来实现。
  • 以声明方式为每个应用注册自定义,通过设置context.initializer.classescontext.listener.classes来实现。
  • 以声明方式为所有应用注册自定义,通过添加一个META-INF/spring.factories并打包成一个jar文件(该应用将它作为一个库)来实现。

SpringApplication会给监听器(即使是在上下文被创建之前就存在的)发送一些特定的ApplicationEvents,然后也会注册监听ApplicationContext发布的事件的监听器,查看Spring Boot特性章节中的Section 23.5, “Application events and listeners” 可以获取完整列表。

在应用上下文刷新前使用EnvironmentPostProcessor自定义Environment是可能的,每个实现都需要注册到META-INF/spring.factories

org.springframework.boot.env.EnvironmentPostProcessor=com.example.YourEnvironmentPostProcessor

68.4 构建ApplicationContext层次结构(添加父或根上下文)

你可以使用ApplicationBuilder类创建parent/child ApplicationContext层次结构,查看'Spring Boot特性'章节的Section 23.4, “Fluent builder API” 获取更多信息。

68.5 创建no-web应用

不是所有的Spring应用都必须是web应用(或web服务)。如果你想在main方法中执行一些代码,但需要启动一个Spring应用去设置需要的底层设施,那使用Spring Boot的SpringApplication特性可以很容易实现。SpringApplication会根据它是否需要一个web应用来改变它的ApplicationContext类,首先你需要做的是去掉servlet API依赖,如果不能这样做(比如基于相同的代码运行两个应用),那你可以明确地调用SpringApplication.setWebEnvironment(false)或设置applicationContextClass属性(通过Java API或使用外部配置)。你想运行的,作为业务逻辑的应用代码可以实现为一个CommandLineRunner,并将上下文降级为一个@Bean定义。